Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: zenstack generate warnings in pnpm repo with custom prisma client output dir #1876

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Nov 19, 2024

fixes #1875

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

📝 Walkthrough

Walkthrough

This pull request includes two main changes: an update to the version number in the JetBrains plugin's build.gradle.kts file from "2.9.0" to "2.9.1" and enhancements to the error handling and path resolution logic in the Prisma plugin's index.ts file. The modifications in index.ts prioritize user-defined paths for the Prisma Client's TypeScript declaration file and improve warning messages related to client generation.

Changes

File Path Change Summary
packages/ide/jetbrains/build.gradle.kts Updated version from "2.9.0" to "2.9.1".
packages/schema/src/plugins/prisma/index.ts Enhanced error handling and path resolution logic for the Prisma Client's TypeScript declaration file. Removed a try-catch block for a more straightforward conditional check.

Assessment against linked issues

Objective Addressed Explanation
Warning during generate since 2.9.0: Could not resolve PrismaClient type declaration path. (1875)

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
packages/schema/src/plugins/prisma/index.ts (2)

86-90: LGTM! Consider adding path validation.

The new logic correctly prioritizes custom Prisma client output paths, fixing the warning issues in pnpm repos.

Consider adding path validation to ensure the custom output path is valid:

 if (clientOutput) {
+    // Validate custom output path
+    if (clientOutput.includes('..')) {
+        console.warn(
+            colors.yellow(
+                'Custom Prisma client output path contains parent directory references (..). This might lead to unexpected behavior.'
+            )
+        );
+    }
     // if a custom prisma client output path is configured, first try treating
     // clientOutputDir as a relative path and locate the index.d.ts file
     prismaClientDtsPath = path.resolve(path.dirname(options.schemaPath), clientOutputDir, 'index.d.ts');
 }

92-105: Consider enhancing error handling with specific error details.

While the fallback logic and warning message are clear, providing more specific error details could help with troubleshooting.

Consider enhancing the error handling:

 } catch (err) {
+    const errorDetails = err instanceof Error ? `: ${err.message}` : '';
     console.warn(
         colors.yellow(
-            `Could not resolve PrismaClient type declaration path. This may break plugins that depend on it.`
+            `Could not resolve PrismaClient type declaration path${errorDetails}. This may break plugins that depend on it.`
         )
     );
+    // Log the attempted paths for debugging
+    console.debug('Attempted paths:', {
+        direct: prismaClientDtsPath,
+        moduleResolution: clientOutputDir
+    });
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 768d94c and 6fe5b48.

⛔ Files ignored due to path filters (13)
  • package.json is excluded by !**/*.json
  • packages/ide/jetbrains/package.json is excluded by !**/*.json
  • packages/language/package.json is excluded by !**/*.json
  • packages/misc/redwood/package.json is excluded by !**/*.json
  • packages/plugins/openapi/package.json is excluded by !**/*.json
  • packages/plugins/swr/package.json is excluded by !**/*.json
  • packages/plugins/tanstack-query/package.json is excluded by !**/*.json
  • packages/plugins/trpc/package.json is excluded by !**/*.json
  • packages/runtime/package.json is excluded by !**/*.json
  • packages/schema/package.json is excluded by !**/*.json
  • packages/sdk/package.json is excluded by !**/*.json
  • packages/server/package.json is excluded by !**/*.json
  • packages/testtools/package.json is excluded by !**/*.json
📒 Files selected for processing (2)
  • packages/ide/jetbrains/build.gradle.kts (1 hunks)
  • packages/schema/src/plugins/prisma/index.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/ide/jetbrains/build.gradle.kts

@ymc9 ymc9 merged commit c0b240c into dev Nov 19, 2024
13 checks passed
@ymc9 ymc9 deleted the fix/issue-1875 branch November 19, 2024 04:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant